Eclipse Platform
Pre-release 3.0

org.eclipse.ui.commands
Interface ICommandService


public interface ICommandService

TODO javadoc

This interface is not intended to be extended or implemented by clients.

EXPERIMENTAL

Since:
3.0
See Also:
ICommandServiceListener

Method Summary
 void addCommandServiceListener(ICommandServiceListener commandServiceListener)
          Registers an instance of ICommandServiceListener to listen for changes to attributes of this instance.
 Set getActiveCommandIds()
           Returns the set of identifiers to active commands.
 void removeCommandServiceListener(ICommandServiceListener commandServiceListener)
          Unregisters an instance of ICommandServiceListener listening for changes to attributes of this instance.
 void setActiveCommandIds(Set activeCommandIds)
          Sets the set of identifiers to active commands.
 

Method Detail

addCommandServiceListener

public void addCommandServiceListener(ICommandServiceListener commandServiceListener)
Registers an instance of ICommandServiceListener to listen for changes to attributes of this instance.

Parameters:
commandServiceListener - the instance of ICommandServiceListener to register. Must not be null. If an attempt is made to register an instance of ICommandServiceListener which is already registered with this instance, no operation is performed.

getActiveCommandIds

public Set getActiveCommandIds()

Returns the set of identifiers to active commands.

Notification is sent to all registered listeners if this attribute changes.

Returns:
the set of identifiers to active commands. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

removeCommandServiceListener

public void removeCommandServiceListener(ICommandServiceListener commandServiceListener)
Unregisters an instance of ICommandServiceListener listening for changes to attributes of this instance.

Parameters:
commandServiceListener - the instance of ICommandServiceListener to unregister. Must not be null. If an attempt is made to unregister an instance of ICommandServiceListener which is not already registered with this instance, no operation is performed.

setActiveCommandIds

public void setActiveCommandIds(Set activeCommandIds)
Sets the set of identifiers to active commands.

Parameters:
activeCommandIds - the set of identifiers to active commands. This set may be empty, but it must not be null. If this set is not empty, it must only contain instances of String.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.